<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class FlashHelper</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> FlashHelper</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A helper for embedding flash into your site using Javascript.</p>
<p class="description"><p>This helper is simply a wrapper for the javascript SwfObject vendor found here:</p><p>http://code.google.com/p/swfobject/</p><p>It has simply two functions, one is optional. If you wish to embed several  flash files into your view, you can initialize the helper (include the javascript  library) once and also set default options for all your subsequent calls.</p><p>Example 1 :</p><p>echo $flash-&gt;renderSwf('test.swf',400,200,'flashy');  echo '&lt;div id=&quot;flashy&quot;&gt;&lt;/div&gt;';</p><p>Example 2 :</p><p>$flash-&gt;init(array('width'=&gt;200,'height'=&gt;100));  echo $flash-&gt;renderSwf('test1.swf');  echo $flash-&gt;renderSwf('test2swf');</p><p>Example 3 :</p><p>echo $flash-&gt;renderSwf('flashfiles/fl_countdown_v3_3.swf?mo=1&amp;da=24&amp;snd=off&amp;co=AA3333',800,250,false,          array('params' =&gt; array('movie'=&gt;'?mo=1&amp;da=24&amp;snd=off&amp;co=AA3333')));</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Alexander Morland</li>
				<li><span class="field">version:</span> 1.2</li>
				<li><span class="field">license:</span> MIT</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_views---helpers---flash.php.html">/views/helpers/flash.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre>Helper
   |
   --<a href="../../cake/cake-cake/AppHelper.html">AppHelper</a>
      |
      --FlashHelper</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$defaultVersionRequirement" title="details" class="var-name">$defaultVersionRequirement</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$helpers" title="details" class="var-name">$helpers</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$initialized" title="details" class="var-name">$initialized</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">array</span>
					<a href="#$options" title="details" class="var-name">$options</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">mixed</span>
										<a href="#init" title="details" class="method-name">init</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#renderSwf" title="details" class="method-name">renderSwf</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$swfFile</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$divDomId</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$defaultVersionRequirement" id="$defaultVersionRequirement"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$defaultVersionRequirement</span>
			 = <span class="var-default"> '9.0.0'</span>			(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used by renderSwf to set a flash version requirement</p>
	
	
		
		

</div>
<a name="var$helpers" id="$helpers"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$helpers</span>
			 = <span class="var-default">array('Javascript')</span>			(line <span class="line-number">34</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

</div>
<a name="var$initialized" id="$initialized"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$initialized</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">58</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used by renderSwf to only call init if it hasnt been done, either  manually or automatically by a former renderSwf()</p>
	
	
		
		

</div>
<a name="var$options" id="$options"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$options</span>
			 = <span class="var-default">array(<br />        'width' =&gt; 100,<br />        'height' =&gt; 100<br />    )</span>			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used for remembering options from init() to each renderSwf</p>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodinit" id="init"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">init</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Optional initializing for setting default parameters and also includes the  swf library. Should be called once, but if using several groups of flashes,  MAY be called several times, once before each group.</p>
	<ul class="tags">
				<li><span class="field">return:</span> String if it was not able to add the script to the view, true if it was</li>
				<li><span class="field">example:</span> example not found</li>
				<li><span class="field">example:</span> example not found</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			init
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$options</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrenderSwf" id="renderSwf"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">renderSwf</span> (line <span class="line-number">104</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Wrapper for the SwfObject::embedSWF method in the vendor. This method will write a javascript code</p>
<p class="description"><p>block that calls that javascript method. If given a dom id as fourth parameter the flash will  replace that dom object. If false is given, a div will be placed at the point in the  page that this method is echo'ed. The last parameter is mainly used for sending in extra settings to  the embedding code, like parameters and attributes. It may also send in flashvars to the flash.</p><p>For doucumentation on what options can be sent, look here:  http://code.google.com/p/swfobject/wiki/documentation</p></p>
	<ul class="tags">
				<li><span class="field">example:</span> example not found</li>
				<li><span class="field">example:</span> example not found</li>
				<li><span class="field">example:</span> example not found</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			renderSwf
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$swfFile</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$divDomId</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$swfFile</span><span class="var-description">: Filename (with paths relative to webroot)</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$width</span><span class="var-description">: if null, will use width set by FlashHelper::init()</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$height</span><span class="var-description">: if null, will use height set by FlashHelper::init()</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$divDomId</span><span class="var-description">: false or string : dom id</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: array('flashvars'=&gt;array(),'params'=&gt;array('wmode'=&gt;'opaque'),'attributes'=&gt;array());          See SwfObject documentation for valid options</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Mon, 08 Nov 2010 12:02:36 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>